doc(WebSiteOptions): improve performance for search code #5075
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis PR improves the performance of the search code by changing the data structures used to store website options from Dictionary to FrozenDictionary and List to HashSet. Sequence diagram for improved code search processsequenceDiagram
participant Client
participant CodeSnippetService
participant FrozenDictionary
Client->>CodeSnippetService: GetCodeAsync(codeFile)
CodeSnippetService->>CodeSnippetService: Split codeFile
CodeSnippetService->>FrozenDictionary: TryGetValue(key.ToLowerInvariant())
Note over FrozenDictionary: Improved lookup performance
FrozenDictionary-->>CodeSnippetService: value
CodeSnippetService-->>Client: formatted code
Class diagram showing updated WebsiteOptions data structure changesclassDiagram
class WebsiteOptions {
+FrozenDictionary~string, string~ SourceCodes
+FrozenDictionary~string, string~ Videos
+FrozenDictionary~string, string~ Links
+HashSet~ThemeOption~ Themes
+WebsiteOptions()
}
note for WebsiteOptions "Changed from Dictionary to FrozenDictionary
Changed List to HashSet for better performance"
class CodeSnippetService {
-FrozenDictionary~string, string~ SourceCodes
+GetCodeAsync(string codeFile) Task~string~
}
note for CodeSnippetService "Changed from Dictionary to FrozenDictionary"
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider using HashSet.Contains() or TryGetValue() instead of FirstOrDefault() to take full advantage of HashSet's O(1) lookup performance when searching for themes
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Co-Authored-By: ice6 <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5075 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 631 631
Lines 27990 27990
Branches 4015 4015
=========================================
Hits 27990 27990 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
improve performance for search code
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号
Description
fixes #5066
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Improve search code performance by using FrozenDictionary and HashSet for website options.
Enhancements: